Method and code generator for integrating different enterprise business applications

ABSTRACT

A method and code generator system for integrating different enterprise business applications is disclosed. In one embodiment, a method for integrating a local business system with an external business system, comprises using a code generator to generate integration source code, wherein using a code generator comprises; interrogating a repository containing integration data by an introspector; and using the integration data with a code filter, wherein the filter generates the integration source code.

FIELD OF THE INVENTION

This invention relates to computer systems, and more specifically to a method and code generator for integrating different enterprise business applications.

BACKGROUND OF THE INVENTION

According to one observer, if the lifeblood of today's corporations is information, then their arteries are the “inter-application interfaces” that facilitate movement of data around the corporate enterprise. This has more recently become known as an “application network”.

For the typical organization, the application network has grown organically into a collection of ad hoc application integration programs. This menagerie has had a very serious impact on businesses as it increases the time for implementing new applications, prevents senior management from getting a clear picture of the business and, in short, clogs the corporate arteries. In spite of the fact that application integration has become crucial to a competitive corporation's survival, it has nevertheless been acceptable in the prior art to handcraft or “hack” custom code for such purposes at enormous long-term cost to the corporation. Long-term application integration decisions have, likewise, been made at the lowest possible levels based solely on individual project criteria. Because of the decidedly difficult nature of these problems, an effective enterprise application integration (EAI) solution has yet to be found.

The advent of the Internet, client/server computing, corporate mergers and acquisitions, globalization and business process re-engineering, have together forced corporate information technology (IT) departments to continually seek out new, and often manual, ways to make different systems talk to each other—regardless of how old some of those systems may be. In the ensuing chaos, inadequate communications systems have had a debilitating effect on IT's abilities to move as fast as the business needs it to.

On the other hand, typical ERP systems are essentially large, integrated packaged applications that support core business functions, such as payroll, manufacturing, general ledger, and human resources. Implementing an ERP system, however, can be an overwhelming process for a number of reasons.

First and foremost, the corporation is buying a product and not building a solution. This means that business units within the corporation must adapt to the product and how it works, not the other way around. Furthermore, today's ERP systems cannot replace all of a corporation's custom solutions. They must, therefore, communicate effectively with other legacy systems in place. Finally, it is not atypical for a corporation to employ more than one and completely different ERP system because a single vendor cannot usually meet every organizational need.

As a result, the options for getting data into and out of an ERP system preclude known approaches used for data warehousing. Each ERP system has a proprietary data model that is constantly being enhanced by its vendor. Writing extract or load routines that manipulate such models is not only complicated, but is also discouraged by the vendor since data validation and business rules inherent in the enterprise application are likely to be bypassed. Instead, ERPs require interaction at the business object level, which deals with specific business entities such as general ledgers, budgets or accounts payable.

FIG. 1 illustrates a block diagram of a prior art integration system 100 having two different business systems. Local business system 105 represents an ERP business environment, such as those described above, for example a system using the Java environment or SAP environment. External business system 125 is an ERP business environment as well, however external system 125 is of a different environment than local system 105; for example a Siebel Business system or Integration Object environment. A problem arises when a user of local system 105 wishes to access external systems 125 within the environment of local system 105. Prior art system 100 solves this problem by having human developer 145 spend hundreds of hours to develop integration code 155. Integration code 155 allows local system 105 to invoke external systems 125 from the local environment. Hand coding by human developer 145 is very expensive, and inefficient because, it may only be used for external system 125. If a second external business system needs to be accessed, human developer 145 must generate new integration code 155. Often, the integration code does not provide a user a coherent interface, with an appearance of being native to local system 105.

In today's rapidly changing environment, the concerted efforts of thousands of developers worldwide are focused on developing a system that satisfies the need for disparate applications to communicate with each other, without the necessity of embedding multiple, customized application-specific translation schemes. This as yet unfulfilled need is grounded in the imperative of the global economy.

BRIEF DESCRIPTION OF THE DRAWINGS

The accompanying drawings, which are included as part of the present specification, illustrate the presently preferred embodiment of the present invention and together with the general description given above and the detailed description of the preferred embodiment given below serve to explain and teach the principles of the present invention.

FIG. 1 illustrates a block diagram of a prior art integration system 100 having two different business systems.

FIG. 2 illustrates a block diagram of an exemplary code generator system 200 according to one embodiment of the present invention.

FIG. 3 illustrates a computer system 300 representing an integrated multi-processor, in which elements of the present invention may be implemented.

FIG. 4 illustrates an exemplary flow diagram 400 of the processing performed by code generator system 200.

FIG. 5 illustrates an exemplary flow diagram 500 of the processing performed between local system 205 and external system 225.

DETAILED DESCRIPTION

A method and code generator system for integrating different enterprise business applications is disclosed. In one embodiment, a method for integrating a local business system with an external business system, comprises using a code generator to generate integration source code, wherein using a code generator comprises; interrogating a repository containing integration data by an introspector; and using the integration data with a code filter, wherein the filter generates the integration source code.

In the following description, for purposes of explanation, specific nomenclature is set forth to provide a thorough understanding of the present invention. However, it will be apparent to one skilled in the art that these specific details are not required in order to practice the present invention.

Some portions of the detailed descriptions, which follow are presented in terms of algorithms and symbolic representations of operations on data bits within a computer memory. These algorithmic descriptions and representations are the means used by those skilled in the data processing arts to most effectively convey the substance of their work to others skilled in the art. An algorithm is here, and generally, conceived to be a self-consistent sequence of steps leading to a desired result. The steps are those requiring physical manipulations of physical quantities. Usually, though not necessarily, these quantities take the form of electrical or magnetic signals capable of being stored, transferred, combined, compared, and otherwise manipulated. It has proven convenient at times, principally for reasons of common usage, to refer to these signals as bits, values, elements, symbols, characters, terms, numbers, or the like.

It should be borne in mind, however, that all of these and similar terms are to be associated with the appropriate physical quantities and are merely convenient labels applied to these quantities. Unless specifically stated otherwise as apparent from the following discussion, it is appreciated that throughout the description, discussions utilizing terms such as “processing” or “computing” or “calculating” or “determining” or “displaying” or the like, refer to the action and processes of a computer system, or similar electronic computing device, that manipulates and transforms data represented as physical (electronic) quantities within the computer system's registers and memories into other data similarly represented as physical quantities within the computer system memories or registers or other such information storage, transmission or display devices.

The present invention also relates to apparatus for performing the operations herein. This apparatus may be specially constructed for the required purposes, or it may comprise a general purpose computer selectively activated or reconfigured by a computer program stored in the computer. Such a computer program may be stored in a computer readable storage medium, such as, but is not limited to, any type of disk including floppy disks, optical disks, CD-ROMs, and magnetic-optical disks, read-only memories (ROMs), random access memories (RAMs), EPROMs, EEPROMs, magnetic or optical cards, or any type of media suitable for storing electronic instructions, and each coupled to a computer system bus.

The algorithms and displays presented herein are not inherently related to any particular computer or other apparatus. Various general purpose systems may be used with programs in accordance with the teachings herein, or it may prove convenient to construct more specialized apparatus to perform the required method steps. The required structure for a variety of these systems will appear from the description below. In addition, the present invention is not described with reference to any particular programming language. It will be appreciated that a variety of programming languages may be used to implement the teachings of the invention as described herein.

FIG. 2 illustrates a block diagram of an exemplary code generator system 200 according to one embodiment of the present invention. Interacting with 200 are local business system 205 and external business system 225. The business systems may be ERP systems. In addition external business system 225 could be a service providing integration objects, such as described in commonly assigned U.S. patent application Ser. No. ______ entitled “Method and System for Using Integration Objects with Enterprise Business Applications,” having inventors Jeffrey Michael Fischer and Mark Coyle, filed on Sep. 28, 2001; and is hereby incorporated by reference.

The core of code generator system 200 is code generator 250. Code generator 250 is a business service that provides the ability to yield integration code for customers to embed into their development environment for the purpose of integrating a local and external business system. Code generator 250 introspects (interrogates) repository 260 for pertinent information and depending on user inputs 270, generator 250 yields integration source code 280. Source code 280 is capable of being embedded in local system 205. Code generator 250 provides for the seamless (transparent to the user) integration of the services of external business system 225 into local business system 205. Although not required, code generator 250 may integrate systems, such as Siebel Integration Objects and Siebel Business Services into local system 205. Siebel Integration Objects allow external systems (e.g., SAP) to obtain or provide data to or from the Siebel Application Environment. Siebel Business Services provide standard or custom-built services for enterprise business. For example, Siebel Business Services provide business logic based on a service's input and data maintained within Siebel's database.

Code generator 250 includes an introspector 251 and a code filter 252. The introspector 251 is responsible for interrogation of repository 260 and code filter 252 is responsible for generating source code 280. Repository 260 contains all the pertinent information (metadata) required for the integration. Metadata is information that describes the format and content of data stored in repository 260. Interrogation of repository 260 provides the metadata needed to produce source code 280 in the form of an adaptor, including any necessary supporting structures. Through the interrogation of repository 260, a canonical form of the selected object (external service) may be produced by introspector 251. The canonical form allows the compression and joining of repository information into a single release to be used by code filter 252.

The following Table 1 shows an example of what business services metadata are used and the information (metadata) obtained form the repository. *TABLE 1 Type Information Obtained Business Services business service name, activation flags and associated comments. Business Service Method business service methods name, activation flags, and associated comments. Business Service Method business service method arguments name, Arg type, usage and comments. Business Service User business service method's user level Props properties name, type, value and comments.

The following Table 2 shows one embodiment of what integration objects are used and the information (metadata) obtained from the repository 260: *TABLE 2 Siebel Type Information Obtained Integration Object integration object name, activation flags and associated comments. Integration Component integration component name, XML name, activation flags, parent integration component, and comments. Integration Component Field integration field name, XML name, activation flags, type, and comments.

The following Table 3 shows the canonical representation of the object (business service from external system 225): *TABLE 3 Attribute Description Class Def Defines the overall object class contains things like: Version id for the class Derived Repository name Is this class an adapter class to native Environment? Access rights for the class itself package/namespace/ . . . name for the class The name of the class Class level comment (pulled from Tools) Property name for the class, normally the same as the class name An array of super classes names (i.e. who are you derived from) An array of interfaces names you implement An array of attribute declarations (i.e. Declaration definition array) An array of method declarations (i.e. Declaration definition array) Meta data stating if this class cardinality. Method Def Only exists for Business Services Method name Property name Comment Access rights Array of arguments. Return type Declaration Def Variable type Variable name Default value Property Cardinality Access rights Access visibility

Based on the exemplary attributes of Table 3, multiple language structures and/or environments (i.e. J2EE, C++ Interfaces and C++ Adapters) can be derived. This canonical form (containing each class definition) is passed on to code filter 252.

Code filter 252 uses the canonical form to add in any language/environment dependent idiosyncrasies. Each code filter 252 may be custom built for a given programming language and/or environment. Utilizing this type of implementation allows a code filter 252 to support multiple programming environments concurrently. By way of example only, a Java Code Filter will be described below. All other code filters would be analogous to the Java Code Filter, by adding specific language dependent idiosyncrasies.

In the case of a Java Filter, code filter 252 would convert the canonical form of a business service to a business service adapter (for an external business service of external business system 225) and a set of Java beans. The adapter provides an interface for interacting with the external business service in a strongly typed interface. The adapter utilizes the set of Java beans produced for input and output method arguments. The following Table 4 shows the two methods invoked by code generator 250. *TABLE 4 Method Name Argument Description GetBusObjList Generates a list of busi- ness objects and key attributes based on some input arguments. BusinessComponentType Which type of business component you are wishing to obtain a list for. RepositoryName Repository name to introspect. OutputBusinessObjectList Return value. GenerateCode Generates source code files for a given business object with a given code filter. BusinessComponentType Which type of business component you are wishing to obtain a list for. RepositoryName Repository name to introspect. OutputCodeGeneratedList Return value.

FIG. 3 illustrates a computer system 300 representing an integrated multi-processor, in which elements of the present invention may be implemented. For example, system 300 may be the architecture of a server running system 200. One embodiment of computer system 300 comprises a system bus 320 for communicating information, and a processor 310 coupled to bus 320 for processing information. Computer system 300 further comprises a random access memory (RAM) or other dynamic storage device 325 (referred to herein as main memory), coupled to bus 320 for storing information and instructions to be executed by processor 310. Main memory 325 also may be used for storing temporary variables or other intermediate information during execution of instructions by processor 310. Computer system 300 also may include a read only memory (ROM) and/or other static storage device 326 coupled to bus 320 for storing static information and instructions used by processor 310. The repository 260 may be implemented in storage 327.

A data storage device 327 such as a magnetic disk or optical disc and its corresponding drive may also be coupled to computer system 300 for storing information and instructions. Computer system 300 can also be coupled to a second I/O bus 350 via an I/O interface 330. A plurality of I/O devices may be coupled to I/O bus 350, including a display device 343, an input device (e.g., an alphanumeric input device 342 and/or a cursor control device 341).

The communication device 340 is for accessing other computers (servers or clients) via a network. The communication device 340 may comprise a modem, a network interface card, or other well known interface device, such as those used for coupling to Ethernet, token ring, or other types of networks.

FIG. 4 illustrates an exemplary flow diagram 400 of the processing performed by code generator system 200. The process commences at start block 401. Flow continues to block 405 where introspector 251 interrogates repository 260 to extract metadata. The metadata may be of business services or integration objects for example. User inputs 270 are also accepted by introspector 251, where the user inputs 270 include selection of a method or service of external business system 225.

Flow continues to processing block 420 where a introspector 251 constructs a canonical representation of the metadata by using the extracted metadata and user inputs 270. At processing block 430, the canonical form (or canonical code class definitions) is passed on to code filter 252. Flow continues to process block 440, where code filter 252 adds language/environment dependent idiosyncrasies, for example, specifically for the Java environment. At processing block 460, code filter 252 generates source code 280 that local system 205 integrates into itself as an adapter with supporting mechanisms for the specific language or environment. Flow stops at block 499.

Having detailed how integration code is generated, the use of generated integration source code within local system 205 will be described. FIG. 5 illustrates an exemplary flow diagram 500 of the processing performed between local system 205 and external system 225. Although described with respect to the Java environment, the processing may be used for any similar environment, or for similar business services.

Process 500 begins at start block 501. Flow continues to processing block 505, where a client of local system 205 sets input parameter bean properties (i.e. selecting a method or service of external system 225). At processing block 510, the client invokes an external business service by passing the input bean to a data bean representing the source code adapter 280. Flow continues to processing block 515, where the data bean logs into external system 525.

At processing block 525, the data bean invokes the external business system's method or service. Flow continues to processing block 530, where an object/method/service manager for external system 525 executes the requested method or service, with the input bean parameters specified. At processing block 535, the executed external service or method returns some output properties to the object/method/service manager.

Flow continues to processing block 540, where the object/method/service manager returns the output properties to the Data Bean. At processing block 545 the Data Bean logs off the external system 225. Flow continues to processing block 550, where the output properties are converted to maintain the format and idiosyncrasies of the output bean's properties. At processing block 555, the client receives the converted output properties by the data bean and flow terminates at block 599.

A method and code generator system for integrating different enterprise business applications is disclosed. Although the present invention has been described with respect to specific examples and subsystems, it will be apparent to those of ordinary skill in the art that the invention is not limited to these specific examples or subsystems but extends to other embodiments as well. The present invention includes all of these other embodiments as specified in the claims that follow. 

1. A computerized method for integrating a local business system with an external business system, comprising: interrogating a repository comprising integration data by an introspector of a code generator, wherein the interrogating comprises obtaining, from the repository, information required for an integration of a component of the external business system into the local business system; and using the integration data with a code filter of the code generator, wherein the filter generates integration source code using one or more user inputs.
 2. The method of claim 1, further comprising: providing the introspector with the one or more user inputs.
 3. The method of claim 2, wherein one of the user inputs is a requested object, method, or service from the external business system.
 4. The method of claim 3, further comprising: generating a set of canonical code class definitions from the integration data and user inputs.
 5. The method of claim 4, wherein the code filter adds language or environment dependent idiosyncrasies to the canonical code class definitions.
 6. The method of claim 5, further comprising: generating an external business service adapter by the code filter.
 7. The method of claim 6, further comprising: compiling the service adapter into the local business system.
 8. A computerized method of integrating a local business system and an external business system, comprising: initiating the invoking of an external business service associated with the external business system by passing one or more user inputs to an adapter, wherein a code filter of a code generator system generates source code using the one or more user inputs, and wherein the source code is integrated by the local business system into itself as the adapter using information obtained from a repository; logging into the external business system by the adapter; invoking the external business service by the adapter; executing the external business service by an object manager associated with the external business system; returning output properties from the external business service to the object manager; returning the output properties from the object manager to the adapter; logging off the external business system by the adapter; and converting the output properties to a format of the local business system.
 9. A computerized system for integrating a local business system with an external business system, comprising: means for interrogating a repository comprising integration data by an introspector of a code generator, wherein the interrogating comprises obtaining, from the repository, information required for an integration of a component of the external business system into the local business system; and means for using the integration data with a code filter of the code generator, wherein the filter generates integration source code using one or more user inputs.
 10. The system of claim 9, further comprising: means for providing the introspector with the one or more user inputs.
 11. The system of claim 10, wherein one of the user inputs is a requested object, method, or service from the external business system.
 12. The system of claim 11, further comprising: means for generating a set of canonical code class definitions from the integration data and user inputs.
 13. The system of claim 12, wherein the code filter adds language or environment dependent idiosyncrasies to the canonical code class definitions.
 14. The system of claim 13, further comprising: means for generating an external business service adapter by the code filter.
 15. The system of claim 14, further comprising: means for compiling the service adapter into the local business system.
 16. A computerized system of integrating a local business system and an external business system, comprising: means for initiating the invoking of an external business service associated with the external business system by passing one or more user inputs to an adapter, wherein a code filter of a code generator system generates source code using the one or more user inputs, and wherein the source code is integrated by the local business system into itself as the adapter using information obtained from a repository; means for logging into the external business system by the adapter; means for invoking the external business service by the adapter; means for executing the external business service by an object manager associated with the external business system; means for returning output properties from the external business service to the object manager; means for returning the output properties from the object manager to the adapter; means for logging off the external business system by the adapter; and means for converting the output properties to a format of the local business system.
 17. A computer-readable medium having stored thereon a plurality of instructions for integrating a local business system with an external business system, the plurality of instructions when executed by a computer, cause the computer to perform: interrogating a repository comprising integration data by an introspector of a code generator, wherein the interrogating comprises obtaining, from the repository, information required for an integration of a component of the external business system into the local business system; and using the integration data with a code filter of the code generator, wherein the filter generates integration source code using one or more user inputs.
 18. The computer-readable medium of claim 17 having stored thereon additional instructions, the additional instructions when executed by a computer, cause the computer to further perform: providing the introspector with the one or more user inputs.
 19. The computer-readable medium of claim 18, wherein one of the user inputs is a requested object, method, or service from the external business system.
 20. The computer-readable medium of claim 19 having stored thereon additional instructions, which when executed by a computer, cause the computer to further perform: generating a set of canonical code class definitions from the integration data and user inputs.
 21. The computer-readable medium of claim 20, wherein the code filter adds language or environment dependent idiosyncrasies to the canonical code class definitions.
 22. The computer-readable medium of claim 21 having stored thereon additional instructions, the additional instructions, which when executed by a computer for using a code generator, cause the computer to further perform: generating an external business service adapter by the code filter.
 23. The computer-readable medium of claim 22 having stored thereon additional instructions, the additional instructions when executed by a computer, cause the computer to further perform: compiling the service adapter into the local business system.
 24. A computer-readable medium having stored thereon a plurality of instructions, the plurality of instructions when executed by a computer for integrating a local business system and an external business system, cause the computer to perform: initiating the invoking of an external business service associated with the external business system by passing one or more user inputs to an adapter, wherein a code filter of a code generator system generates source code using the one or more user inputs, and wherein the source code is integrated by the local business system into itself as the adapter using information obtained from a repository; logging into the external business system by the adapter; invoking the external business service by the adapter; executing the external business service by an object manager associated with the external business system; returning output properties from the external business service to the object manager; returning the output properties from the object manager to the adapter; logging off the external business system by the adapter; and converting the output properties to a format of the local business system.
 25. A computerized system for integrating a local business system with an external business system, comprising: a code generator comprising an introspector and a code filter to generate integration source code using one or more user inputs; a repository coupled to the code generator, wherein the repository stores integration data associated with an external business system; and a local business system coupled to the code generators; and wherein the introspector interrogates the repository for integration data associated with an external business service, and wherein the introspector generates a set of canonical code class definitions from the integration data.
 26. (canceled)
 27. The system of claim 26, wherein the code filter generates integration source code.
 28. The system of claim 27, wherein the integration source code is compiled into the local business system to seamlessly provide access to the external business service.
 29. A method comprising: receiving a user input that identifies a component of an external computing system; obtaining from a repository, in response to the user input, information required for an integration of the component into a local computing system; generating a canonical form of an adaptor for the component in response to the information; and converting the canonical form of the adaptor into a first implementation-specific form of the adaptor; and converting the canonical form of the adaptor into a second implementation-specific form of the adaptor.
 30. The method of claim 29, wherein the first implementation-specific form of the adaptor is configured for use with a first programming language, and the second implementation-specific form of the adaptor is configured for use with a second programming language that is different from the first programming language.
 31. The method of claim 29, wherein the first implementation-specific form of the adaptor is configured for use with a first programming environment, and the second implementation-specific form of the adaptor is configured for use with a second programming environment that is different from the first programming environment.
 32. The method of claim 29, wherein the canonical form of the adaptor comprises a class definition and a declaration definition.
 33. The method of claim 32, wherein the class definition comprises indicators of super classes from which the class definition is derived.
 34. The method of claim 32, wherein: the class definition comprises access rights for a class defined by the class definition; and the first implementation-specific form of the adaptor is a Java implementation.
 35. The method of claim 29, wherein: the first implementation-specific form of the adaptor is a Java implementation; and the second implementation-specific form of the adaptor is a C++ implementation.
 36. The method of claim 29, wherein the first implementation-specific form of the adaptor and the second implementation-specific form of the adaptor each comprise source code for the local computing system.
 37. The method of claim 29, wherein the component of the external computing system is a service of the external computing system. 